<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>GmailHttpAuthenticator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/com/googlecode/gmail4j/auth/GmailHttpAuthenticator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright (c) 2008-2009 Tomas Varaneckas</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * <a href="http://www.varaneckas.com" target="alexandria_uri">http://www.varaneckas.com</a></em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * </em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * This program is free software: you can redistribute it and/or modify</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * it under the terms of the GNU General Public License as published by</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * the Free Software Foundation, either version 3 of the License, or</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * (at your option) any later version.</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> * </em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * This program is distributed in the hope that it will be useful,</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * GNU General Public License for more details.</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * </em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * You should have received a copy of the GNU General Public License</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * along with this program. If not, see &lt;<a href="http://www.gnu.org/licenses/&gt;." target="alexandria_uri">http://www.gnu.org/licenses/&gt;.</a></em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> com.googlecode.gmail4j.auth;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.net.Authenticator;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.net.PasswordAuthentication;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.GmailClient;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.rss.RssGmailClient;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">/**</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * Http {@link Authenticator} for {@link GmailClient} implementations that</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * require HTTP access to Gmail service. </em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * Activate it with {@link Authenticator#setDefault(Authenticator)}:</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;&lt;blockquote&gt;&lt;pre&gt;</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> *     Credentials login = new Credentials(username, password);</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> *     Authenticator.setDefault(new GmailHttpAuthenticator(login));</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;&lt;/blockquote&gt;&lt;p&gt;</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * {@link RssGmailClient} automatically activates this on </em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * {@link RssGmailClient#init()}.</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * </em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * @see Authenticator</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * @see Credentials</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * @see RssGmailClient</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * @author Tomas Varaneckas &amp;lt;tomas.varaneckas@gmail.com&amp;gt;</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * @version $Id: GmailHttpAuthenticator.java 6 2009-03-20 08:59:14Z tomas.varaneckas $</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * @since 0.1</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> */</em>
<a name="48" href="#48">48</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../com/googlecode/gmail4j/auth/GmailHttpAuthenticator.html">GmailHttpAuthenticator</a> <strong class="jxr_keyword">extends</strong> Authenticator {
<a name="49" href="#49">49</a>      
<a name="50" href="#50">50</a>      <em class="jxr_javadoccomment">/**</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * Logger</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     */</em>
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log log = LogFactory.getLog(GmailHttpAuthenticator.<strong class="jxr_keyword">class</strong>);
<a name="54" href="#54">54</a>      
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * Credentials given as response to &lt;a href="<a href="http://mail.google.com" target="alexandria_uri">http://mail.google.com</a>"&gt;</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * mail.google.com&lt;/a&gt; server request.</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     */</em>
<a name="59" href="#59">59</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../com/googlecode/gmail4j/auth/Credentials.html">Credentials</a> credentials;
<a name="60" href="#60">60</a>      
<a name="61" href="#61">61</a>      <em class="jxr_javadoccomment">/**</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * Constructor that sets {@link #credentials}</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * </em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * @param credentials Gmail login</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     */</em>
<a name="66" href="#66">66</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../com/googlecode/gmail4j/auth/GmailHttpAuthenticator.html">GmailHttpAuthenticator</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../com/googlecode/gmail4j/auth/Credentials.html">Credentials</a> credentials) {
<a name="67" href="#67">67</a>          <strong class="jxr_keyword">this</strong>.credentials = credentials;
<a name="68" href="#68">68</a>      }
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      @Override
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">protected</strong> PasswordAuthentication getPasswordAuthentication() {
<a name="72" href="#72">72</a>          <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="73" href="#73">73</a>              log.debug(<span class="jxr_string">"Password authentication request: "</span> 
<a name="74" href="#74">74</a>                      + getRequestingPrompt());
<a name="75" href="#75">75</a>          }
<a name="76" href="#76">76</a>          <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"mail.google.com"</span>.equals(getRequestingHost())) {
<a name="77" href="#77">77</a>              log.debug(<span class="jxr_string">"Gmail request detected, returning login credentials"</span>);
<a name="78" href="#78">78</a>              <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PasswordAuthentication(credentials.getUsername(), 
<a name="79" href="#79">79</a>                      credentials.getPasword());
<a name="80" href="#80">80</a>          }
<a name="81" href="#81">81</a>          log.debug(<span class="jxr_string">"Unknown authentication request, will return nothing"</span>);
<a name="82" href="#82">82</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="83" href="#83">83</a>      }
<a name="84" href="#84">84</a>      
<a name="85" href="#85">85</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

